home *** CD-ROM | disk | FTP | other *** search
/ SGI Performance Co-Pilot 1.3 / SGI Performance Co-Pilot 1.3.iso / dist / dist6.4 / pcp.idb / usr / share / catman / u_man / cat3 / PMAPI / pmgetindomarchive.z / pmgetindomarchive
Text File  |  1997-04-03  |  5KB  |  67 lines
  1.  
  2.  
  3.  
  4. PPPPMMMMGGGGEEEETTTTIIIINNNNDDDDOOOOMMMMAAAARRRRCCCCHHHHIIIIVVVVEEEE((((3333))))                                      PPPPMMMMGGGGEEEETTTTIIIINNNNDDDDOOOOMMMMAAAARRRRCCCCHHHHIIIIVVVVEEEE((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ppppmmmmGGGGeeeettttIIIInnnnDDDDoooommmmAAAArrrrcccchhhhiiiivvvveeee - get instance identifiers for a performance metrics
  10.      instance domain
  11.  
  12. CCCC SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ppppccccpppp////ppppmmmmaaaappppiiii....hhhh>>>>
  14.  
  15.      iiiinnnntttt ppppmmmmGGGGeeeettttIIIInnnnDDDDoooommmmAAAArrrrcccchhhhiiiivvvveeee((((ppppmmmmIIIInnnnDDDDoooommmm iiiinnnnddddoooommmm,,,, iiiinnnntttt ********iiiinnnnssssttttlllliiiisssstttt,,,, cccchhhhaaaarrrr ************nnnnaaaammmmeeeelllliiiisssstttt))))
  16.  
  17.      cccccccc ............ ----llllppppccccpppp
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      Provided the current Performance Metrics Application Programming
  21.      Interface (PMAPI) context, is associated with an archive log,
  22.      ppppmmmmGGGGeeeettttIIIInnnnDDDDoooommmmAAAArrrrcccchhhhiiiivvvveeee will scan the union of all the instance domain metadata
  23.      for the instance domain _i_n_d_o_m, and return via _i_n_s_t_l_i_s_t the internal
  24.      instance identifiers for all instances, and via _n_a_m_e_l_i_s_t the full
  25.      external identifiers for all instances.
  26.  
  27.      This routine is an specialized version of the more general PMAPI routine
  28.      ppppmmmmGGGGeeeettttIIIInnnnDDDDoooommmm.
  29.  
  30.      The number of instances found is returned as the function value (else
  31.      less than zero to indicate an error).
  32.  
  33.      The value for the instance domain _i_n_d_o_m is typically extracted from a
  34.      _p_m_D_e_s_c structure, following a call to ppppmmmmLLLLooooooookkkkuuuuppppDDDDeeeesssscccc(3) for a particular
  35.      performance metric.
  36.  
  37.      The resulting lists of instance identifiers (_i_n_s_t_l_i_s_t and _n_a_m_e_l_i_s_t), and
  38.      the names that the elements of _n_a_m_e_l_i_s_t point to, will have been
  39.      allocated by ppppmmmmGGGGeeeettttIIIInnnnDDDDoooommmmAAAArrrrcccchhhhiiiivvvveeee with two calls to mmmmaaaalllllllloooocccc(3C), and it is
  40.      the responsibility of the caller to _f_r_e_e(_i_n_s_t_l_i_s_t) and _f_r_e_e(_n_a_m_e_l_i_s_t) to
  41.      release the space when it is no longer required.
  42.  
  43.      When the result of ppppmmmmGGGGeeeettttIIIInnnnDDDDoooommmmAAAArrrrcccchhhhiiiivvvveeee is less than one, both _i_n_s_t_l_i_s_t and
  44.      _n_a_m_e_l_i_s_t are undefined (no space will have been allocated, and so calling
  45.      ffffrrrreeeeeeee(3C) is a singularly bad idea).
  46.  
  47. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  48.      PPPPMMMMAAAAPPPPIIII(3), ppppmmmmGGGGeeeettttIIIInnnnDDDDoooommmm(3), ppppmmmmLLLLooooooookkkkuuuuppppDDDDeeeesssscccc(3), ppppmmmmLLLLooooooookkkkuuuuppppIIIInnnnDDDDoooommmmAAAArrrrcccchhhhiiiivvvveeee(3) and
  49.      ppppmmmmNNNNaaaammmmeeeeIIIInnnnDDDDoooommmmAAAArrrrcccchhhhiiiivvvveeee(3).
  50.  
  51. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  52.      PPPPMMMM____EEEERRRRRRRR____NNNNOOOOTTTTAAAARRRRCCCCHHHHIIIIVVVVEEEE
  53.           the current PMAPI context is not associated with an archive log
  54.  
  55.      PPPPMMMM____EEEERRRRRRRR____IIIINNNNDDDDOOOOMMMM____LLLLOOOOGGGG
  56.           _i_n_d_o_m is not a defined instance domain identifier for the archive
  57.           log
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.